Welcome to WinHelp Inspector

WinHelp Inspector is a useful WinHelp tool that allows you to display important statistics about the WinHelp Help files on your system.

You will find that WinHelp Inspector is useful in a variety of scenarios, for example:

•	WinHelp Inspector lets you check for consistency within your WinHelp Help systems. For example, assume that you are creating four Help projects for applications within a suite. You can use WinHelp Inspector to browse through these systems, checking to make sure you used the same font type or macros. The WinHelp Inspector gives you the opportunity to be consistent with your Help systems, a mark of professionalism for any Help author.

•	WinHelp Inspector's Keyword Reporter allows you to easily print a report of your Help system's K Keywords. You can make sure you've used them consistently and look for additional opportunities for keywords.

•	WinHelp Inspector is great when you want to check out existing WinHelp Help systems. You may want to consult other Help systems for ideas, conventions and inspirations. Using WinHelp Inspector, you can see how existing Help systems were created: the startup macros and DLLs, the fonts used, and other design-related information.

 WinHelp Inspector is the best way to get statistics quickly because it works right on the HLP file. You can also see statistics by opening an HLP file from RoboHELP. The file is converted into its component source files and you can then run RoboHELP reports to get additional statistics about the project.

See Also

Software requirements

Starting WinHelp Inspector

Using WinHelp Inspector

Printing keyword reports

WinHelp Inspector statistics

Contacting eHelp Corporation


Software requirements

To use WinHelp Inspector, you need Windows 3.1, 95, 98, NT 4.0, or 2000 installed on your system, plus some WinHelp Help files (these files have an HLP extension) to inspect.

See Also

Starting WinHelp Inspector

Using WinHelp Inspector


Starting WinHelp Inspector

To start WinHelp Inspector from RoboHELP:

•	From the RoboHELP Explorer Tools tab, double-click WinHelp Inspector [image]. The WinHelp Inspector window displays.

To start WinHelp Inspector from RoboHELP Office:

1	If you are using Windows 3.1, 95, 98, NT 4.0, or 2000, from the Start menu, select Programs, RoboHELP Office, RoboHELP Office. The RoboHELP Office Starter appears.

If you are using Windows 3.51, open the RoboHELP Office program group.

2	Double-click WinHelp Inspector [image]. The WinHelp Inspector window displays.

See Also

Using WinHelp Inspector


Using WinHelp Inspector

To use WinHelp Inspector:

1	Select the drive and directory where the WinHelp Help file is located.

2	To find a Help file on a network drive, click Network and browse for the drive and path that includes the file.

3	In File Name, select the HLP file you want to inspect. WinHelp Inspector displays statistics about the Help system.

See Also

Printing Keyword reports

Viewing Help systems

Viewing topics by keyword

WinHelp Inspector statistics


Printing keyword reports

You can print the following two keyword reports in WinHelp Inspector:

•	Keywords by Topic: A two-column report that displays topics and their associated keywords. This report is handy if you want to review all keywords that are associated with each topic. The last line in the report indicates the total number of topics that are in the Help system.

•	Topics by Keyword:  A two-column report that displays keywords and their associated topics. This report is handy if you want to review all keywords that are included in the Help system and quickly find out what topics use them. The last line in the report indicates the total number of keywords in the Help system.

To print a report:

1	Click Report. The Report dialog appears.

2	Select the type of report to print.

3	Click Print. WinHelp Inspector prints the report.

See Also

Viewing Help systems

Viewing topics by keyword

WinHelp Inspector statistics


Viewing Help systems

You can open the Help system right from the WinHelp Inspector window. For WinHelp 4 Help systems, the Contents tab appears. For WinHelp 3.1 Help systems, the Contents topic is displayed in the WinHelp 3 window.

To view the contents file for the Help system you are inspecting:

•	Click View File. The Contents topic or Contents tab is displayed.

 See Also

Printing Keyword reports

Viewing topics by keyword

WinHelp Inspector statistics


Viewing topics by keyword

WinHelp Inspector provides a way for you to look up topics based on their associated keywords. If more than one topic uses the same keyword, all of them are listed so you can select one to view.

To look up topics by their keywords:

1	In Search Keywords, select the keyword or keyword phrase.

2	Click View. The topic appears in the WinHelp window.

3	If more than one topic uses the same keyword, the Topics Found dialog appears. From this dialog, select the topic to view, and then click Display to see the topic in the WinHelp window.

See Also

Printing Keyword reports

Viewing Help systems

WinHelp Inspector statistics


WinHelp Inspector statistics

When you select a Help system in WinHelp Inspector, the following statistics are displayed:

  Field:	Description:

Name	The name of the Help system.
Date	The system date of the Help file.
Size	The size of the compiled Help file.
Topic Titles	A list of the text strings that have been defined as "titles" in the Help system (this corresponds to the $ tag). You can scroll through the drop-down list to see all of the titles. This feature is useful to detect any duplicate or similar topic entries.
Search Keywords	A list of the text strings that have been defined as K keywords in the Help system. You can scroll through the drop-down list to see all of the keywords.
Fonts	A list of the fonts that are used to display text in the Help system. You can scroll through the drop-down list to see all of the fonts. The font name, size, font style, and color are listed. This makes it much easier when you are about to select the fonts and font attributes you want to use in your own help system. Also, the Fonts combo-box allows you to quickly check your Help system and check what font types, sizes and color combinations are specified, allowing you to spot any unwanted fonts immediately.
Startup Macros	A list of the macros that are executed when the Help system is started. You can scroll through the drop-down list to see all of the startup macros. This allows you to find out what DLLs are being used.
Title	The caption that displays in the Help Viewer window when the Help system is accessed.
Compression	Indicates whether compression was used when the Help system was compiled. By compressing a Help system, you save space on the installation diskettes as well as on the end users' systems.
Help File Generated	The day, date, and time the Help system was last compiled. This information is useful if you are comparing Help systems to find the most current version.
Copyright notice	If the Help system includes a copyright notice, the text of the notice is displayed. You can use this as a quick check to be sure your copyright dates are current, as well as to check for correct wording.
Number of Search Keywords	The total number of keywords in the Help system.
See Also

Printing Keyword reports

Viewing Help systems

Viewing topics by keyword


eHelp Corporation headquarters

eHelp Corporation is the worldwide leader in Help authoring solutions. Software developers, Help authors, technical writers, and documentation experts worldwide turn to eHelp Corporation for state-of-the-art Help authoring and Internet/intranet solutions.

Corporate Headquarters

Address:	eHelp Corporation 7777 Fay Avenue, Suite 201 La Jolla, CA 92037 U.S.A.
Telephone:	1-858-551-2485
Fax:	1-858-551-2486
World Wide Web:	www.blue-sky.com
Office Hours:	Monday to Friday 6:00 A.M. to 5:00 P.M. Pacific Time

eHelp Corporation Sales Department

eHelp Corporation Technical Support Department


Sales

eHelp Corporation's professional sales staff is ready to answer your sales questions Monday to Friday from 6:00 A.M. to 5:00 P.M. Pacific Time.

Contact your sales representative to hear about the latest products, the Subscription Plan, training, upgrade options and prices, and more. If you have a technical question or problem, please contact Technical Support.

Contacting your eHelp Corporation Sales Representative

Sales Phone:	1-800-677-4946
International (including Canada):	1-858-459-6365
Sales Fax:	1-858-459-6366
World Wide Web:	www.blue-sky.com
Sales Email:	sales@blue-sky.com
When sending email, please include your company name, city, and state to ensure your request is handled promptly.


Technical Support

At eHelp Corporation, we work hard to provide you with intuitive technical products. Additionally, we try to provide superior online and print documentation to enable you to work independently. If you have a technical question that you can't answer with the provided tools, please contact our Technical Support department. All of our Technical Support representatives are eager to answer your questions and help you create the best Help systems possible.

Note: You must be a registered user to access eHelp Corporation support services. eHelp Corporation support services are subject to the prices, terms, and conditions in place at the time the service is used.

eHelp Corporation's Technical Support services includes email, telephone, and Web-based support on our corporate Web site (www.blue-sky.com).

Help Us Help You

When contacting Technical Support via phone or email, please provide the following information for the fastest possible service:

•	Product serial number (registration number)

•	Your name, company name, and phone number

•	Exact product name and version number

•	Type of operating system (e.g., Windows 95)

•	Version of Microsoft Word (if using RoboHELP for WinHelp)

•	Browser and version (if creating HTML-based Help)

•	Complete description of the issue, including steps to reproduce it

•	Exact wording of any messages displayed when you encountered the problem

•	Steps taken to resolve the problem

•	All previous email threads with eHelp Corporation about the issue, if any

For current hours of operation and details about all support offerings, please:

•	Visit our Web site (www.blue-sky.com)

•	Email us at supportnews@blue-sky.com to receive an automated reply listing all of your support options.

•	Call us at 858-551-2194.


Premium Support

Premium Support entitles plan members to priority Technical Support access through a dedicated telephone line and a dedicated email address. Plan members receive direct access to eHelp Corporation's seasoned Senior Technical Support Engineers.

Premium Support plans are available for current and previous versions of eHelp Corporation products.